/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.platformservice.appconfig;

import org.proteusframework.core.api.model.IMetadata;
import org.proteusframework.platformservice.IServicePlugin;

/**
 * Provides white label configuration capabilities for a Proteus application. For example, the application configuration
 * can describe the text for the application title bar, the splash screen graphic, which UI elements should be enabled
 * or disabled, including the ability to launch the application in a headless mode.
 * <p/>
 * Anything that is deemed to be an application configurable property should be managed by this service.
 */
public interface IAppConfigService extends IServicePlugin, IMetadata
{
    /**
     * Identifies the name of the application.
     *
     * @return Application name
     */
    String getAppName();


    /**
     * Gets the default name for a new project, the current date/time as a string.
     *
     * @return The default project name (file name only, not path)
     */
    String getDefaultProjectName();

    /**
     * Identify the default directory used to hold collections of projects. <code>IPersistenceService</code> instances
     * may or may not choose to honor this property.
     * <p/>
     * A logical default value is the user's home directory.
     *
     * @return Default projects directory
     */
    String getDefaultProjectsDirectory();
}
